Labview.h

Go to the documentation of this file.

#include "Compile_Options.h"
#ifndef _LABVIEW_H
#define _LABVIEW_H

/*
 **************************************************************
 * Defines, Macros and Typedefs 
 **************************************************************/
/*** Constant Macros ***/
#ifndef TRUE
 #define TRUE (1u)
#endif
#ifndef CLEAR
 #define CLEAR (0u)
#endif
#ifndef BITS_IN_NIBBLE
 #define BITS_IN_NIBBLE (4u)
#endif
#ifndef BITS_IN_BYTE
 #define BITS_IN_BYTE (8u)
#endif
#ifndef BYTES_IN_16
 #define BYTES_IN_16  (2u)
#endif
#ifndef BYTES_IN_32
 #define BYTES_IN_32  (4u)
#endif

#ifndef BIT_DEFINITION
 #define BIT_DEFINITION
 #define BIT0  (1u << 0u)
 #define BIT1  (1u << 1u)
 #define BIT2  (1u << 2u)
 #define BIT3  (1u << 3u)
 #define BIT4  (1u << 4u)
 #define BIT5  (1u << 5u)
 #define BIT6  (1u << 6u)
 #define BIT7  (1u << 7u)
 #define BIT8  (1u << 8u)
 #define BIT9  (1u << 9u)
 #define BIT10 (1u << 10)
 #define BIT11 (1u << 11)
 #define BIT12 (1u << 12)
 #define BIT13 (1u << 13)
 #define BIT14 (1u << 14)
 #define BIT15 (1u << 15)
 #define BIT16 (1u << 16)
 #define BIT17 (1u << 17)
 #define BIT18 (1u << 18)
 #define BIT19 (1u << 19)
 #define BIT20 (1u << 20)
 #define BIT21 (1u << 21)
 #define BIT22 (1u << 22)
 #define BIT23 (1u << 23)
 #define BIT24 (1u << 24)
 #define BIT25 (1u << 25)
 #define BIT26 (1u << 26)
 #define BIT27 (1u << 27)
 #define BIT28 (1u << 28)
 #define BIT29 (1u << 29)
 #define BIT30 (1u << 30)
 #define BIT31 (1u << 31)
#endif



#ifdef USE_GENERIC_EVB_BOARD
#define LABVIEW_SCI       (0u)
#endif
#ifdef USE_ARD2_V1
#define LABVIEW_SCI       (1u)
#endif
#ifdef USE_ARD2_V2
#define LABVIEW_SCI       (1u)
#endif
#ifdef USE_ARD2_V3
#define LABVIEW_SCI       (1u)
#endif

#define SIZE_OF_SOF       (5u)
#define SIZE_OF_SOF_FOR_D (4u)
#define SIZE_OF_SOF_FOR_T (3u)

/* Sizes */
#define LABVIEW_COMPOSITE_MESSAGE_SIZE (256u)
#define LABVIEW_CMD_MSG_SIZE ((uint8_t)0x04u)

/* Diagnostics response array locations */
#define LV_RESPONSE_TIME     ((uint8_t)0u)
#define LV_RESPONSE_CMD      ((uint8_t)4u)
#define LV_RESPONSE_ARG1     ((uint8_t)5u)
#define LV_RESPONSE_ARG2     ((uint8_t)6u)
#define LV_RESPONSE_ARG3     ((uint8_t)7u)
#define LV_RESPONSE_PASS     ((uint8_t)8u)
#define LV_RESPONSE_RESPONSE ((uint8_t)9u)
#define LV_RESPONSE_ADDER    ((uint8_t)8u)

/*** Function Macros ***/
#ifndef N_ELEMENTS
 #define N_ELEMENTS(X)           (sizeof(X)/sizeof(*(X)))
#endif

#define LV_SEND_IN_PARALLEL (1u)
#define LV_SEND_SERIALLY  (0u)
/*** Enums ***/
enum SCI_START_OF_FRAME_INDEX
{
  LV_MS_MSG = 0, LV_MP_MSG, LV_TI_MSG, LV_TS_MSG, LV_TT_MSG,
  LV_DA_MSG, LV_DS_MSG, LV_RS_MSG, LV_RR_MSG, LV_RE_MSG, LV_DD_MSG
};
enum LABVIEW_SIZE
{
  LV_8 = 1, LV_16,LV_24, LV_32
};
/* Index for incoming array */
enum LABVIEW_RX_ARRAY
{
  LV_CMD = 0, LV_ARG1, LV_ARG2, LV_ARG3
};


/*** TypeDefs ***/

/*
 **************************************************************
 * Declarations 
 **************************************************************/
/*** Extern ***/
extern uint8_t gau8LabViewRxCmd[LABVIEW_CMD_MSG_SIZE];
/*** Globals ***/
//extern void (const * pvfnMixNMatch[2])(uint8_t* pu8Data, 
//                                      uint8_t u8Length, 
//                                      uint8_t u8Type);
/*** Static Globals ***/

/*
 **************************************************************
 * Function Prototypes 
 **************************************************************/
/*
 ******************************************************************************
 *
 * Function:          vfnDisplaySCIData()
 *
 */
void vfnDisplaySCIData(uint8_t u8Type, uint8_t u8BitSizeOfSample, \
                       uint8_t u8NOfStreams, uint16_t u16NOfSamples, \
                       uint8_t* pu8Data);
/*
 ******************************************************************************
 *
 * Function:          vfnDisplaySCIDataParallel()
 *
 */
void vfnDisplaySCIDataParallel(uint8_t u8Type, uint8_t u8BitSizeOfSample, \
                       uint8_t u8NOfStreams, uint16_t u16NOfSamples, \
                       uint8_t* pu8Data);
/*
 ******************************************************************************
 *
 * Function:          vfnLVTriggerEvent()
 *
 */
void vfnLVTriggerEvent(const uint8_t u8Mask);
/*
 ******************************************************************************
 *
 * Function:          vfnDisplaySCIRegistersInTable()
 *
 */
void vfnDisplaySCIRegistersInTable(uint8_t u8TableType, \
                                   uint16_t u16InitAddress, \
                                   uint16_t u16NOfData, \
                                   uint8_t* pu8RegTable);
/*
 ******************************************************************************
 *
 * Function:          u8fnLabViewSendMSorMP()
 *
 */
uint8_t  u8fnLabViewSendMSorMP(uint8_t *pu8Data, uint8_t u8Length, \
                               uint8_t u8Mode, uint8_t u8LabViewMsgType);
/*
 ******************************************************************************
 *
 * Function:          vfnLVMixAndMatch()
 *
 */
void vfnLVMixAndMatch(uint8_t* pu8Data, uint8_t u8Length, uint8_t u8Type);
/*
 ******************************************************************************
 *
 * Function:          vfnLVMixAndMatchParallel()
 *
 */
void vfnLVMixAndMatchParallel(uint8_t* pu8Data, 
                              uint8_t u8Length, 
                              uint8_t u8Type);
/*
 ******************************************************************************
 *
 * Function:          u8fnLVConfigRxCmd()
 *
 */
uint8_t u8fnLVConfigRxCmd(void);
/*
 ******************************************************************************
 *
 * Function:          u8fnLVReceiveCmd()
 *
 */
uint8_t u8fnLVReceiveCmd(void);
/*
 ******************************************************************************
 *
 * Function:          vfnLVEnable()
 *
 */
void vfnLVEnable(uint8_t u8Enable);
/*
 ******************************************************************************
 *
 * Function:          u8fnLVWaitForTxPort()
 *
 */
uint8_t u8fnLVWaitForTxPort(void);
 
#endif /* _FILENAME_H */